home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 21 / AACD 21.iso / AACD / Utilities / EvenMore / Docs / Plugins.doc < prev   
Text File  |  2001-05-01  |  2KB  |  71 lines
  1.  
  2.    EVENMORE PLUGINS
  3.  
  4. ********************************************************************
  5. The plugins feature of EvenMore is currently not programmed, and
  6. so you cannot write your own plugins for at as yet.
  7. ********************************************************************
  8.  
  9.  
  10.  
  11.  
  12. Here is a brief description of the plugins available for EvenMore
  13.  
  14.  
  15.      guide2text.plugin
  16.  
  17.  
  18.    This will automatically detect if a file is an AmigaGuide
  19.    document, and if it is, convert it to text.
  20.    All text formatting will be accounted for, using ANSI ESC code
  21.    sequences.
  22.  
  23. --------------------------------------------------------------------
  24.  
  25.  
  26.    PROGRAMMING YOUR OWN PLUGINS
  27.  
  28.  
  29. Here is a brief description of how to program your own plugins for
  30. EvenMore. The plugin format for EvenMore is subject to change, so
  31. I cannot be held responsible if your plugins don't function properly
  32. in future versions of EvenMore. This is an WORK_IN_PROGRESS feature,
  33. so changes WILL BE MADE!
  34.  
  35.  
  36.    Standard procedure types for plugins
  37.  
  38.      Emp_init()
  39.  
  40.    The initilization call of the plugin
  41.  
  42.      Emp_info()
  43.  
  44.    Returns a string of information which is displayed in the plugin
  45.    page of the information window.
  46.  
  47.  
  48. --------------------------------------------------------------------
  49.  
  50.    FILE IO PLUGIN
  51.  
  52.  
  53.      memory, length := Emp_init(memory, length)
  54.  
  55.  
  56.    This is the call made to the Init() procedure in the plugin.
  57.    It is called after the file has been loaded into memory, and
  58.    before any of the file parsing has been done on it.
  59.  
  60.    <memory> is the start address of the raw file data
  61.  
  62.    <length> is the length of the raw file data
  63.      NB: Length should be the last character in your new buffer,
  64.          not necessarily the end of the buffer.
  65.  
  66.  
  67.    You can if you wish, alter this buffer. Or, if you wish, create a
  68.    new buffer, and copy modified contents of the old buffer into
  69.    this new buffer, as long as you dispose the old buffer and return
  70.    the new memory address and new length of the buffer back to the
  71.    main program.